-
Notifications
You must be signed in to change notification settings - Fork 3
Add links to kit items. #117
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Why are we using googles tracked links for these? It'd be nicer to just use the full links |
I will switch to the full urls and hopefully that will fix the CI tests |
From the spam in the CI log it looks like it's timed out waiting for a response when trying to check the links. And yeah I agree, it'd be nicer to use the true URLs rather than goo.gl shortened ones. It's not like we're asking them to type the URLs in manually or anything. |
content/kit/_index.md
Outdated
| [Large CamCon](http://uk.farnell.com/camdenboss/ctb9400-2/terminal-block-pluggable-2pos/dp/3882275) | 2 | 7.5mm | | | ||
| [Medium CamCon](http://uk.farnell.com/camdenboss/ctb9200-2a/terminal-block-pluggable-2pos/dp/3881854) | 2 | 5mm | | | ||
| [Small CamCon](http://uk.farnell.com/camdenboss/ctb92he-2/terminal-block-pluggable-2pos/dp/1717047) | 3 | 3.81mm | 1 additionally found on Raspberry Pi power cable | | ||
| Raspberry Pi Power Cable | 1 | Micro USB to small CamCon | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no link here (Should there be???)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Raspberry Pi power cable is a custom part we make ourselves, so there isn't really a page online describing it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fair enough :)
Pro tip: Amazon URLs can be shortened by replacing the stuff between
are both equivalent. It's not really worth changing it unless you really want to to. EDIT: same goes for Farnell:
are equivalent. |
"spellcheck": "mdspell --en-gb --report --ignore-acronyms --ignore-numbers --no-suggestions 'content/**/*.md'", | ||
"broken-link-local": "blcl --recursive --ordered --exclude-external ./public/", | ||
"broken-link-all": "blcl --recursive --ordered ./public/", | ||
"broken-link-all": "blcl --recursive --exclude farnell --ordered ./public/", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why are we excluding farnell here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Farnell links are excluded as they cause the link checker to hang indefinitely. See earlier build https://circleci.com/gh/sourcebots/docs/535 It is not entirely clear why this is the case. One theory was that the User Agent for the link checker was being filtered, but this is not the case.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please could we have an inline comment to that effect?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Meta (and well beyond the scope of this PR): this is a class of error which I see as unavoidable and a reason not to have external link checking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Inline comment added: de78cf8
content/kit/_index.md
Outdated
| Raspberry Pi Power Cable | 1 | Micro USB to small CamCon | | | ||
| Part | Quantity | Specification | Notes | | ||
|----------------------------------------------------------------------------------------------------------|----------|-------------------------------|--------------------------------------------------| | ||
| [Battery Bag](https://hobbyking.com/en_us/lithium-polymer-charge-pack-25x33cm-jumbo-sack.html) | 1 | | | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Style suggestion: footnote style links might make this table easier to read:
| [Battery Bag][battery-bag] | 1 | ... |
[battery-bag]: https://hobbyking.com/en_us/lithium-polymer-charge-pack-25x33cm-jumbo-sack.html
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am unable to find a reference to this syntax in the Hugo documentation. Please could you provide a link? It certainly seems like a good idea, as having very long urls in the table feels inelegant
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This style of links (search for "Reference-style links") is part of the original markdown syntax, so I don't know whether it would be documented explicitly by hugo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed in 79586e4
As json comments are not a defined standard, I have followed this recommendation from the NPM mailing list https://groups.google.com/forum/#!msg/nodejs/NmL7jdeuw0M/yTqI05DRQrIJ
As teams are asking for this now (at the tech day), I suggest this is merged and the package.json is fixed in a separate PR |
Add links to kit items. Have attempted to get as close to the kit we provide if I was unable to find the exact item.